Microsoft Cognitive Language Service - Document Analysis (preview:2024-11-15)

2025/10/08 • 3 new, 3 deleted methods

AnalyzeDocumentsSubmitJob (new)
Description :  Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation.
Reference :  Link ¶

⚼ Request

POST:  /analyze-documents/jobs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The input for the analyze documents operation. ,
Required: True ,
}
{
displayName:
{
Description: Name for the task. ,
Required: False ,
}
string ,
analysisInput:
{
Description: Contains the input to be analyzed. ,
Required: True ,
}
{
documents:
{
Description: The input documents to be analyzed. ,
Required: False ,
}
[
{
id:
{
Description: A unique, non-empty document identifier. ,
Required: True ,
}
string ,
source:
{
Description: The location of the input document to process. ,
Required: True ,
}
{
kind:
{
Description: The kind of the document location. ,
Enum:
{
AzureBlob: The document is a URL. ,
}
,
Required: True ,
}
enum ,
}
,
target:
{
Description: The location where the processed document will be stored. ,
Required: True ,
}
{
kind:
{
Description: The kind of the document location. ,
Enum:
{
AzureBlob: The document is a URL. ,
}
,
Required: True ,
}
enum ,
}
,
language:
{
Description: (Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default. ,
Required: False ,
}
string ,
}
,
]
,
}
,
tasks:
{
Description: List of tasks to be performed as part of the LRO. ,
Required: True ,
}
[
{
taskName:
{
Description: task name ,
Required: False ,
}
string ,
kind:
{
Description: The kind of task to perform. ,
Enum:
{
PiiEntityRecognition: PII entity recognition task ,
ExtractiveSummarization: Extractive summarization task ,
AbstractiveSummarization: Abstractive summarization task ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultLanguage:
{
Description: Default language to use for records. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
AnalyzeDocumentsJobStatus (new)
Description :  Get the status of a document analysis job. A job can consist of one or more tasks. After all tasks succeed, the job transitions to the succeeded state and results are available for each task.
Reference :  Link ¶

⚼ Request

GET:  /analyze-documents/jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
jobId:
{
Description: job ID ,
Format: uuid ,
Required: True ,
}
string ,
showStats:
{
Description: (Optional) if set to true, response will contain request and document level statistics. ,
Required: False ,
}
boolean ,
top:
{
Description: The maximum number of resources to return from the collection. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: An offset into the collection of the first resource to be returned. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
displayName:
{
Description: display name ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date and time job created ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: Date and time job expires ,
Format: date-time ,
Required: False ,
}
string ,
jobId:
{
Description: job ID ,
Format: uuid ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: last updated date and time ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: status ,
Enum:
{
notStarted: Not started status ,
running: Running status ,
succeeded: Succeeded status ,
partiallyCompleted: Partially completed status ,
failed: Failed status ,
cancelled: Cancelled status ,
cancelling: Cancelling status ,
}
,
Required: True ,
}
enum ,
errors:
{
Description: errors ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: next link ,
Required: False ,
}
string ,
tasks:
{
Description: List of tasks. ,
Required: True ,
}
{
completed:
{
Description: Count of completed tasks. ,
Format: int32 ,
Required: True ,
}
integer ,
failed:
{
Description: Count of failed tasks. ,
Format: int32 ,
Required: True ,
}
integer ,
inProgress:
{
Description: Count of inprogress tasks. ,
Format: int32 ,
Required: True ,
}
integer ,
total:
{
Description: Count of total tasks. ,
Format: int32 ,
Required: True ,
}
integer ,
items:
{
Description: Enumerable of Analyze documents job results. ,
Required: False ,
}
[
{
lastUpdateDateTime:
{
Description: The last updated time in UTC for the task. ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: The status of the task at the mentioned last update time. ,
Enum:
{
notStarted: Not started status ,
running: Running status ,
succeeded: Succeeded status ,
partiallyCompleted: Partially completed status ,
failed: Failed status ,
cancelled: Cancelled status ,
cancelling: Cancelling status ,
}
,
Required: True ,
}
enum ,
taskName:
{
Description: task name ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the task. ,
Enum:
{
PiiEntityRecognitionLROResults: PII entity recognition LRO results ,
ExtractiveSummarizationLROResults: Extractive summarization LRO results ,
AbstractiveSummarizationLROResults: Abstractive summarization LRO results ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
statistics:
{
Description: if showStats=true was specified in the request this field will contain information about the request payload. ,
Required: False ,
}
{
documentsCount:
{
Description: Number of documents submitted in the request. ,
Format: int32 ,
Required: True ,
}
integer ,
validDocumentsCount:
{
Description: Number of valid documents. This excludes empty, over-size limit or non-supported languages documents. ,
Format: int32 ,
Required: True ,
}
integer ,
erroneousDocumentsCount:
{
Description: Number of invalid documents. This includes empty, over-size limit or non-supported languages documents. ,
Format: int32 ,
Required: True ,
}
integer ,
transactionsCount:
{
Description: Number of transactions for the request. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
AnalyzeDocumentsCancelJob (new)
Description :  Cancel a long-running Text Analysis job.
Reference :  Link ¶

⚼ Request

POST:  /analyze-documents/jobs/{jobId}:cancel
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID to cancel. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
AnalyzeDocumentsSubmitJob (removed)
Description :  Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation.
Reference :  Link ¶

⚼ Request

POST:  /analyze-documents/jobs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: The input for the analyze documents operation. ,
Required: True ,
}
{
displayName:
{
Description: Name for the task. ,
Required: False ,
}
string ,
analysisInput:
{
Description: Contains the input to be analyzed. ,
Required: True ,
}
{
documents:
{
Description: The input documents to be analyzed. ,
Required: False ,
}
[
{
id:
{
Description: A unique, non-empty document identifier. ,
Required: True ,
}
string ,
source:
{
Description: The location of the input document to process. ,
Required: True ,
}
{
kind:
{
Description: The kind of the document location. ,
Enum:
{
AzureBlob: The document is a URL. ,
}
,
Required: True ,
}
enum ,
}
,
target:
{
Description: The location where the processed document will be stored. ,
Required: True ,
}
{
kind:
{
Description: The kind of the document location. ,
Enum:
{
AzureBlob: The document is a URL. ,
}
,
Required: True ,
}
enum ,
}
,
language:
{
Description: (Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default. ,
Required: False ,
}
string ,
}
,
]
,
}
,
tasks:
{
Description: List of tasks to be performed as part of the LRO. ,
Required: True ,
}
[
{
taskName:
{
Description: task name ,
Required: False ,
}
string ,
kind:
{
Description: The kind of task to perform. ,
Enum:
{
PiiEntityRecognition: PII entity recognition task ,
ExtractiveSummarization: Extractive summarization task ,
AbstractiveSummarization: Abstractive summarization task ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultLanguage:
{
Description: Default language to use for records. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
AnalyzeDocumentsJobStatus (removed)
Description :  Get the status of a document analysis job. A job can consist of one or more tasks. After all tasks succeed, the job transitions to the succeeded state and results are available for each task.
Reference :  Link ¶

⚼ Request

GET:  /analyze-documents/jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
jobId:
{
Description: job ID ,
Format: uuid ,
Required: True ,
}
string ,
showStats:
{
Description: (Optional) if set to true, response will contain request and document level statistics. ,
Required: False ,
}
boolean ,
top:
{
Description: The maximum number of resources to return from the collection. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: An offset into the collection of the first resource to be returned. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
displayName:
{
Description: display name ,
Required: False ,
}
string ,
createdDateTime:
{
Description: Date and time job created ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: Date and time job expires ,
Format: date-time ,
Required: False ,
}
string ,
jobId:
{
Description: job ID ,
Format: uuid ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: last updated date and time ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: status ,
Enum:
{
notStarted: Not started status ,
running: Running status ,
succeeded: Succeeded status ,
partiallyCompleted: Partially completed status ,
failed: Failed status ,
cancelled: Cancelled status ,
cancelling: Cancelling status ,
}
,
Required: True ,
}
enum ,
errors:
{
Description: errors ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: next link ,
Required: False ,
}
string ,
tasks:
{
Description: List of tasks. ,
Required: True ,
}
{
completed:
{
Description: Count of completed tasks. ,
Format: int32 ,
Required: True ,
}
integer ,
failed:
{
Description: Count of failed tasks. ,
Format: int32 ,
Required: True ,
}
integer ,
inProgress:
{
Description: Count of inprogress tasks. ,
Format: int32 ,
Required: True ,
}
integer ,
total:
{
Description: Count of total tasks. ,
Format: int32 ,
Required: True ,
}
integer ,
items:
{
Description: Enumerable of Analyze documents job results. ,
Required: False ,
}
[
{
lastUpdateDateTime:
{
Description: The last updated time in UTC for the task. ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: The status of the task at the mentioned last update time. ,
Enum:
{
notStarted: Not started status ,
running: Running status ,
succeeded: Succeeded status ,
partiallyCompleted: Partially completed status ,
failed: Failed status ,
cancelled: Cancelled status ,
cancelling: Cancelling status ,
}
,
Required: True ,
}
enum ,
taskName:
{
Description: task name ,
Required: False ,
}
string ,
kind:
{
Description: Kind of the task. ,
Enum:
{
PiiEntityRecognitionLROResults: PII entity recognition LRO results ,
ExtractiveSummarizationLROResults: Extractive summarization LRO results ,
AbstractiveSummarizationLROResults: Abstractive summarization LRO results ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
statistics:
{
Description: if showStats=true was specified in the request this field will contain information about the request payload. ,
Required: False ,
}
{
documentsCount:
{
Description: Number of documents submitted in the request. ,
Format: int32 ,
Required: True ,
}
integer ,
validDocumentsCount:
{
Description: Number of valid documents. This excludes empty, over-size limit or non-supported languages documents. ,
Format: int32 ,
Required: True ,
}
integer ,
erroneousDocumentsCount:
{
Description: Number of invalid documents. This includes empty, over-size limit or non-supported languages documents. ,
Format: int32 ,
Required: True ,
}
integer ,
transactionsCount:
{
Description: Number of transactions for the request. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
AnalyzeDocumentsCancelJob (removed)
Description :  Cancel a long-running Text Analysis job.
Reference :  Link ¶

⚼ Request

POST:  /analyze-documents/jobs/{jobId}:cancel
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID to cancel. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}